API Documentation
Static Public Member Functions | List of all members
nkGraphics::ContentLoader Class Referencefinal

Utility class that allows to load content through their declaration files. More...

Static Public Member Functions

static nkExport::ExporterLoadResult inputData (const nkMemory::StringView &filePath)
 
static std::string inputDataStr (const nkMemory::StringView &filePath)
 
static nkExport::ExporterLoadResult inputDataSources (const nkMemory::StringView &sources)
 
static bool outputData (const nkMemory::StringView &content, const nkMemory::StringView &path)
 
static bool saveTreeDeclaration (nkExport::Node *tree, const nkMemory::StringView &pathFromData)
 
static bool saveObjectDeclaration (nkExport::Exportable *object, const nkMemory::StringView &pathFromData)
 
static ContentLoadResultTexture loadTextureDeclaration (const nkMemory::StringView &pathFromData, bool loadResource=true)
 
static ContentLoadResultTexture processTextureSources (const nkMemory::StringView &sources, bool loadResource=true)
 
static ContentLoadResultTexture processTextureTree (nkExport::Node *tree, bool loadResource=true)
 
static ContentLoadResultSampler loadSamplerDeclaration (const nkMemory::StringView &pathFromData, bool loadResource=true)
 
static ContentLoadResultSampler processSamplerSources (const nkMemory::StringView &sources, bool loadResource=true)
 
static ContentLoadResultSampler processSamplerTree (nkExport::Node *tree, bool loadResource=true)
 
static ContentLoadResultProgram loadShaderProgramDeclaration (const nkMemory::StringView &pathFromData, bool loadResource=true)
 
static ContentLoadResultProgram processShaderProgramSources (const nkMemory::StringView &sources, bool loadResource=true)
 
static ContentLoadResultProgram processShaderProgramTree (nkExport::Node *tree, bool loadResource=true)
 
static ContentLoadResultShaderMemorySlot loadShaderMemorySlotDeclaration (const nkMemory::StringView &pathFromData)
 
static ContentLoadResultShaderMemorySlot processShaderMemorySlotSources (const nkMemory::StringView &sources)
 
static ContentLoadResultShaderMemorySlot processShaderMemorySlotDeclarationTree (nkExport::Node *tree)
 
static ContentLoadResultConstantBuffer loadConstantBufferDeclaration (const nkMemory::StringView &pathFromData)
 
static ContentLoadResultConstantBuffer processConstantBufferSources (const nkMemory::StringView &sources)
 
static ContentLoadResultConstantBuffer processConstantBufferDeclarationTree (nkExport::Node *tree)
 
static ContentLoadResultBuffer loadBufferDeclaration (const nkMemory::StringView &pathFromData, bool loadResource=true)
 
static ContentLoadResultBuffer processBufferSources (const nkMemory::StringView &sources, bool loadResource=true)
 
static ContentLoadResultBuffer processBufferDeclarationTree (nkExport::Node *tree, bool loadResource=true)
 
static ContentLoadResultShader loadShaderDeclaration (const nkMemory::StringView &pathFromData, bool loadResource=true)
 
static ContentLoadResultShader processShaderDeclarationSources (const nkMemory::StringView &sources, bool loadResource=true)
 
static ContentLoadResultShader processShaderDeclarationTree (nkExport::Node *tree, bool loadResource=true)
 
static ContentLoadResultPass loadPassDeclaration (const nkMemory::StringView &pathFromData)
 
static ContentLoadResultPass processPassSources (const nkMemory::StringView &sources)
 
static ContentLoadResultPass processPassTree (nkExport::Node *tree)
 
static ContentLoadResultCompositor loadCompositorDeclaration (const nkMemory::StringView &pathFromData, bool loadResource=true)
 
static ContentLoadResultCompositor processCompositorSources (const nkMemory::StringView &sources, bool loadResource=true)
 
static ContentLoadResultCompositor processCompositorTree (nkExport::Node *tree, bool loadResource=true)
 
static ContentLoadResultMesh loadMeshDeclaration (const nkMemory::StringView &pathFromData, bool loadResource=true)
 
static ContentLoadResultMesh processMeshSources (const nkMemory::StringView &sources, bool loadResource=true)
 
static ContentLoadResultMesh processMeshTree (nkExport::Node *tree, bool loadResource=true)
 
static ContentLoadResultNode loadNodeDeclaration (const nkMemory::StringView &pathFromData)
 
static ContentLoadResultNode processNodeSources (const nkMemory::StringView &sources)
 
static ContentLoadResultNode processNodeTree (nkExport::Node *tree)
 
static ContentLoadResultBlendState loadBlendStateDeclaration (const nkMemory::StringView &pathFromData, bool loadResource=true)
 
static ContentLoadResultBlendState processBlendStateSources (const nkMemory::StringView &sources, bool loadResource=true)
 
static ContentLoadResultBlendState processBlendStateTree (nkExport::Node *tree, bool loadResource=true)
 
static ContentLoadResultDepthStencilState loadDepthStencilStateDeclaration (const nkMemory::StringView &pathFromData, bool loadResource=true)
 
static ContentLoadResultDepthStencilState processDepthStencilStateSources (const nkMemory::StringView &sources, bool loadResource=true)
 
static ContentLoadResultDepthStencilState processDepthStencilStateTree (nkExport::Node *tree, bool loadResource=true)
 
static ContentLoadResultRasterState loadRasterStateDeclaration (const nkMemory::StringView &pathFromData, bool loadResource=true)
 
static ContentLoadResultRasterState processRasterStateSources (const nkMemory::StringView &sources, bool loadResource=true)
 
static ContentLoadResultRasterState processRasterStateTree (nkExport::Node *tree, bool loadResource=true)
 
static ContentLoadResultCamera loadCameraDeclaration (const nkMemory::StringView &pathFromData)
 
static ContentLoadResultCamera processCameraSources (const nkMemory::StringView &sources)
 
static ContentLoadResultCamera processCameraTree (nkExport::Node *tree)
 
static ContentLoadResultRenderQueue loadRenderQueueDeclaration (const nkMemory::StringView &pathFromData)
 
static ContentLoadResultRenderQueue processRenderQueueSources (const nkMemory::StringView &sources)
 
static ContentLoadResultRenderQueue processRenderQueueTree (nkExport::Node *tree)
 
static ContentLoadResultCompositorNode appendCompositorNodeFromFile (const nkMemory::StringView &pathFromData, Compositor *parent)
 
static ContentLoadResultCompositorNode appendCompositorNodeFromSources (const nkMemory::StringView &sources, Compositor *parent)
 
static ContentLoadResultCompositorNode appendCompositorNodeFromTree (nkExport::Node *tree, Compositor *parent)
 

Detailed Description

Utility class that allows to load content through their declaration files.

Member Function Documentation

◆ inputData()

static nkExport::ExporterLoadResult nkGraphics::ContentLoader::inputData ( const nkMemory::StringView filePath)
static

Inputs data from a file and returns associated tree, if parsing can occur. It will use Json parsing.

Parameters
filePathThe file path, relative to working directory. See nkResources::ResourceManager for path naming convention.
Returns
The result after loading designated file.

◆ inputDataStr()

static std::string nkGraphics::ContentLoader::inputDataStr ( const nkMemory::StringView filePath)
static

Inputs data from a file and only get the sources.

Parameters
filePathThe file to find.
Returns
The result after loading designated memory chunk.

◆ inputDataSources()

static nkExport::ExporterLoadResult nkGraphics::ContentLoader::inputDataSources ( const nkMemory::StringView sources)
static

Inputs data from memory and returns associated tree, if parsing can occur. It will use Json parsing.

Parameters
sourcesThe sources to parse.
Returns
The result after loading designated memory chunk.

◆ outputData()

static bool nkGraphics::ContentLoader::outputData ( const nkMemory::StringView content,
const nkMemory::StringView path 
)
static

Writes data to a file.

Parameters
contentThe content to write.
pathThe path, relative to working directory, to output the file to. See nkResources::ResourceManager for path naming convention.
Returns
If the data could succesfully be output (true) or not (false).

◆ saveTreeDeclaration()

static bool nkGraphics::ContentLoader::saveTreeDeclaration ( nkExport::Node tree,
const nkMemory::StringView pathFromData 
)
static

Saves an aready exported tree into a file.

Parameters
treeThe tree to export.
pathFromDataThe path, relative to working directory, to output the file to. See nkResources::ResourceManager for path naming convention.
Returns
If the data could succesfully be output (true) or not (false).

◆ saveObjectDeclaration()

static bool nkGraphics::ContentLoader::saveObjectDeclaration ( nkExport::Exportable object,
const nkMemory::StringView pathFromData 
)
static

Saves an exportable into a file.

Parameters
objectThe object to serialize and export.
pathFromDataThe path, relative to working directory, to output the file to. See nkResources::ResourceManager for path naming convention.
Returns
If the data could succesfully be output (true) or not (false).

◆ loadTextureDeclaration()

static ContentLoadResultTexture nkGraphics::ContentLoader::loadTextureDeclaration ( const nkMemory::StringView pathFromData,
bool  loadResource = true 
)
static

Loads a texture declaration, from a file.

Parameters
pathFromDataThe file path, relative to working directory. See nkResources::ResourceManager for path naming convention.
loadResourceWhether the resource should be loaded in place (true) or not (false).
Returns
The load result.

◆ processTextureSources()

static ContentLoadResultTexture nkGraphics::ContentLoader::processTextureSources ( const nkMemory::StringView sources,
bool  loadResource = true 
)
static

Loads a texture declaration, from memory.

Parameters
sourcesThe memory chunk to interpret.
loadResourceWhether the resource should be loaded in place (true) or not (false).
Returns
The load result.

◆ processTextureTree()

static ContentLoadResultTexture nkGraphics::ContentLoader::processTextureTree ( nkExport::Node tree,
bool  loadResource = true 
)
static

Loads a texture declaration, from an existing tree.

Parameters
treeThe tree to interpret.
loadResourceWhether the resource should be loaded in place (true) or not (false).
Returns
The load result.

◆ loadSamplerDeclaration()

static ContentLoadResultSampler nkGraphics::ContentLoader::loadSamplerDeclaration ( const nkMemory::StringView pathFromData,
bool  loadResource = true 
)
static

Loads a sampler declaration, from a file.

Parameters
pathFromDataThe file path, relative to working directory. See nkResources::ResourceManager for path naming convention.
loadResourceWhether the resource should be loaded in place (true) or not (false).
Returns
The load result.

◆ processSamplerSources()

static ContentLoadResultSampler nkGraphics::ContentLoader::processSamplerSources ( const nkMemory::StringView sources,
bool  loadResource = true 
)
static

Loads a sampler declaration, from memory.

Parameters
sourcesThe memory chunk to interpret.
loadResourceWhether the resource should be loaded in place (true) or not (false).
Returns
The load result.

◆ processSamplerTree()

static ContentLoadResultSampler nkGraphics::ContentLoader::processSamplerTree ( nkExport::Node tree,
bool  loadResource = true 
)
static

Loads a sampler declaration, from an existing tree.

Parameters
treeThe tree to interpret.
loadResourceWhether the resource should be loaded in place (true) or not (false).
Returns
The load result.

◆ loadShaderProgramDeclaration()

static ContentLoadResultProgram nkGraphics::ContentLoader::loadShaderProgramDeclaration ( const nkMemory::StringView pathFromData,
bool  loadResource = true 
)
static

Loads a shader program declaration, from a file.

Parameters
pathFromDataThe file path, relative to working directory. See nkResources::ResourceManager for path naming convention.
loadResourceWhether the resource should be loaded in place (true) or not (false).
Returns
The load result.

◆ processShaderProgramSources()

static ContentLoadResultProgram nkGraphics::ContentLoader::processShaderProgramSources ( const nkMemory::StringView sources,
bool  loadResource = true 
)
static

Loads a shader program declaration, from memory.

Parameters
sourcesThe memory chunk to interpret.
loadResourceWhether the resource should be loaded in place (true) or not (false).
Returns
The load result.

◆ processShaderProgramTree()

static ContentLoadResultProgram nkGraphics::ContentLoader::processShaderProgramTree ( nkExport::Node tree,
bool  loadResource = true 
)
static

Loads a shader program declaration, from an existing tree.

Parameters
treeThe tree to interpret.
loadResourceWhether the resource should be loaded in place (true) or not (false).
Returns
The load result.

◆ loadShaderMemorySlotDeclaration()

static ContentLoadResultShaderMemorySlot nkGraphics::ContentLoader::loadShaderMemorySlotDeclaration ( const nkMemory::StringView pathFromData)
static

Loads a memory slot declaration, from a file.

Parameters
pathFromDataThe file path, relative to working directory. See nkResources::ResourceManager for path naming convention.
Returns
The load result.

◆ processShaderMemorySlotSources()

static ContentLoadResultShaderMemorySlot nkGraphics::ContentLoader::processShaderMemorySlotSources ( const nkMemory::StringView sources)
static

Loads a memory slot declaration, from memory.

Parameters
sourcesThe memory chunk to interpret.
Returns
The load result.

◆ processShaderMemorySlotDeclarationTree()

static ContentLoadResultShaderMemorySlot nkGraphics::ContentLoader::processShaderMemorySlotDeclarationTree ( nkExport::Node tree)
static

Loads a memory slot declaration, from an existing tree.

Parameters
treeThe tree to interpret.
Returns
The load result.

◆ loadConstantBufferDeclaration()

static ContentLoadResultConstantBuffer nkGraphics::ContentLoader::loadConstantBufferDeclaration ( const nkMemory::StringView pathFromData)
static

Loads a constant buffer declaration, from a file.

Parameters
pathFromDataThe file path, relative to working directory. See nkResources::ResourceManager for path naming convention.
Returns
The load result.

◆ processConstantBufferSources()

static ContentLoadResultConstantBuffer nkGraphics::ContentLoader::processConstantBufferSources ( const nkMemory::StringView sources)
static

Loads a constant buffer declaration, from memory.

Parameters
sourcesThe memory chunk to interpret.
Returns
The load result.

◆ processConstantBufferDeclarationTree()

static ContentLoadResultConstantBuffer nkGraphics::ContentLoader::processConstantBufferDeclarationTree ( nkExport::Node tree)
static

Loads a constant buffer declaration, from an existing tree.

Parameters
treeThe tree to interpret.
Returns
The load result.

◆ loadBufferDeclaration()

static ContentLoadResultBuffer nkGraphics::ContentLoader::loadBufferDeclaration ( const nkMemory::StringView pathFromData,
bool  loadResource = true 
)
static

Loads a buffer declaration, from a file.

Parameters
pathFromDataThe file path, relative to working directory. See nkResources::ResourceManager for path naming convention.
loadResourceWhether the resource should be loaded in place (true) or not (false).
Returns
The load result.

◆ processBufferSources()

static ContentLoadResultBuffer nkGraphics::ContentLoader::processBufferSources ( const nkMemory::StringView sources,
bool  loadResource = true 
)
static

Loads a buffer declaration, from memory.

Parameters
sourcesThe memory chunk to interpret.
loadResourceWhether the resource should be loaded in place (true) or not (false).
Returns
The load result.

◆ processBufferDeclarationTree()

static ContentLoadResultBuffer nkGraphics::ContentLoader::processBufferDeclarationTree ( nkExport::Node tree,
bool  loadResource = true 
)
static

Loads a buffer declaration, from an existing tree.

Parameters
treeThe tree to interpret.
loadResourceWhether the resource should be loaded in place (true) or not (false).
Returns
The load result.

◆ loadShaderDeclaration()

static ContentLoadResultShader nkGraphics::ContentLoader::loadShaderDeclaration ( const nkMemory::StringView pathFromData,
bool  loadResource = true 
)
static

Loads a shader declaration, from a file.

Parameters
pathFromDataThe file path, relative to working directory. See nkResources::ResourceManager for path naming convention.
loadResourceWhether the resource should be loaded in place (true) or not (false).
Returns
The load result.

◆ processShaderDeclarationSources()

static ContentLoadResultShader nkGraphics::ContentLoader::processShaderDeclarationSources ( const nkMemory::StringView sources,
bool  loadResource = true 
)
static

Loads a shader declaration, from memory.

Parameters
sourcesThe memory chunk to interpret.
loadResourceWhether the resource should be loaded in place (true) or not (false).
Returns
The load result.

◆ processShaderDeclarationTree()

static ContentLoadResultShader nkGraphics::ContentLoader::processShaderDeclarationTree ( nkExport::Node tree,
bool  loadResource = true 
)
static

Loads a shader declaration, from an existing tree.

Parameters
treeThe tree to interpret.
loadResourceWhether the resource should be loaded in place (true) or not (false).
Returns
The load result.

◆ loadPassDeclaration()

static ContentLoadResultPass nkGraphics::ContentLoader::loadPassDeclaration ( const nkMemory::StringView pathFromData)
static

Loads a pass declaration, from a file.

Parameters
pathFromDataThe file path, relative to working directory. See nkResources::ResourceManager for path naming convention.
Returns
The load result.

◆ processPassSources()

static ContentLoadResultPass nkGraphics::ContentLoader::processPassSources ( const nkMemory::StringView sources)
static

Loads a pass declaration, from memory.

Parameters
sourcesThe memory chunk to interpret.
Returns
The load result.

◆ processPassTree()

static ContentLoadResultPass nkGraphics::ContentLoader::processPassTree ( nkExport::Node tree)
static

Loads a pass declaration, from an existing tree.

Parameters
treeThe tree to interpret.
Returns
The load result.

◆ loadCompositorDeclaration()

static ContentLoadResultCompositor nkGraphics::ContentLoader::loadCompositorDeclaration ( const nkMemory::StringView pathFromData,
bool  loadResource = true 
)
static

Loads a compositor declaration, from a file.

Parameters
pathFromDataThe file path, relative to working directory. See nkResources::ResourceManager for path naming convention.
loadResourceWhether the resource should be loaded in place (true) or not (false).
Returns
The load result.

◆ processCompositorSources()

static ContentLoadResultCompositor nkGraphics::ContentLoader::processCompositorSources ( const nkMemory::StringView sources,
bool  loadResource = true 
)
static

Loads a compositor declaration, from memory.

Parameters
sourcesThe memory chunk to interpret.
loadResourceWhether the resource should be loaded in place (true) or not (false).
Returns
The load result.

◆ processCompositorTree()

static ContentLoadResultCompositor nkGraphics::ContentLoader::processCompositorTree ( nkExport::Node tree,
bool  loadResource = true 
)
static

Loads a compositor declaration, from an existing tree.

Parameters
treeThe tree to interpret.
loadResourceWhether the resource should be loaded in place (true) or not (false).
Returns
The load result.

◆ loadMeshDeclaration()

static ContentLoadResultMesh nkGraphics::ContentLoader::loadMeshDeclaration ( const nkMemory::StringView pathFromData,
bool  loadResource = true 
)
static

Loads a mesh declaration, from a file.

Parameters
pathFromDataThe file path, relative to working directory. See nkResources::ResourceManager for path naming convention.
loadResourceWhether the resource should be loaded in place (true) or not (false).
Returns
The load result.

◆ processMeshSources()

static ContentLoadResultMesh nkGraphics::ContentLoader::processMeshSources ( const nkMemory::StringView sources,
bool  loadResource = true 
)
static

Loads a mesh declaration, from memory.

Parameters
sourcesThe memory chunk to interpret.
loadResourceWhether the resource should be loaded in place (true) or not (false).
Returns
The load result.

◆ processMeshTree()

static ContentLoadResultMesh nkGraphics::ContentLoader::processMeshTree ( nkExport::Node tree,
bool  loadResource = true 
)
static

Loads a mesh declaration, from an existing tree.

Parameters
treeThe tree to interpret.
loadResourceWhether the resource should be loaded in place (true) or not (false).
Returns
The load result.

◆ loadNodeDeclaration()

static ContentLoadResultNode nkGraphics::ContentLoader::loadNodeDeclaration ( const nkMemory::StringView pathFromData)
static

Loads a node declaration, from a file.

Parameters
pathFromDataThe file path, relative to working directory. See nkResources::ResourceManager for path naming convention.
Returns
The load result.

◆ processNodeSources()

static ContentLoadResultNode nkGraphics::ContentLoader::processNodeSources ( const nkMemory::StringView sources)
static

Loads a node declaration, from memory.

Parameters
sourcesThe memory chunk to interpret.
Returns
The load result.

◆ processNodeTree()

static ContentLoadResultNode nkGraphics::ContentLoader::processNodeTree ( nkExport::Node tree)
static

Loads a node declaration, from an existing tree.

Parameters
treeThe tree to interpret.
Returns
The load result.

◆ loadBlendStateDeclaration()

static ContentLoadResultBlendState nkGraphics::ContentLoader::loadBlendStateDeclaration ( const nkMemory::StringView pathFromData,
bool  loadResource = true 
)
static

Loads a blend state declaration, from a file.

Parameters
pathFromDataThe file path, relative to working directory. See nkResources::ResourceManager for path naming convention.
loadResourceWhether the resource should be loaded in place (true) or not (false).
Returns
The load result.

◆ processBlendStateSources()

static ContentLoadResultBlendState nkGraphics::ContentLoader::processBlendStateSources ( const nkMemory::StringView sources,
bool  loadResource = true 
)
static

Loads a blend state declaration, from memory.

Parameters
sourcesThe memory chunk to interpret.
loadResourceWhether the resource should be loaded in place (true) or not (false).
Returns
The load result.

◆ processBlendStateTree()

static ContentLoadResultBlendState nkGraphics::ContentLoader::processBlendStateTree ( nkExport::Node tree,
bool  loadResource = true 
)
static

Loads a blend state declaration, from an existing tree.

Parameters
treeThe tree to interpret.
loadResourceWhether the resource should be loaded in place (true) or not (false).
Returns
The load result.

◆ loadDepthStencilStateDeclaration()

static ContentLoadResultDepthStencilState nkGraphics::ContentLoader::loadDepthStencilStateDeclaration ( const nkMemory::StringView pathFromData,
bool  loadResource = true 
)
static

Loads a depth and stencil state declaration, from a file.

Parameters
pathFromDataThe file path, relative to working directory. See nkResources::ResourceManager for path naming convention.
loadResourceWhether the resource should be loaded in place (true) or not (false).
Returns
The load result.

◆ processDepthStencilStateSources()

static ContentLoadResultDepthStencilState nkGraphics::ContentLoader::processDepthStencilStateSources ( const nkMemory::StringView sources,
bool  loadResource = true 
)
static

Loads a depth and stencil state declaration, from memory.

Parameters
sourcesThe memory chunk to interpret.
loadResourceWhether the resource should be loaded in place (true) or not (false).
Returns
The load result.

◆ processDepthStencilStateTree()

static ContentLoadResultDepthStencilState nkGraphics::ContentLoader::processDepthStencilStateTree ( nkExport::Node tree,
bool  loadResource = true 
)
static

Loads a depth and stencil state declaration, from an existing tree.

Parameters
treeThe tree to interpret.
loadResourceWhether the resource should be loaded in place (true) or not (false).
Returns
The load result.

◆ loadRasterStateDeclaration()

static ContentLoadResultRasterState nkGraphics::ContentLoader::loadRasterStateDeclaration ( const nkMemory::StringView pathFromData,
bool  loadResource = true 
)
static

Loads a raster state declaration, from a file.

Parameters
pathFromDataThe file path, relative to working directory. See nkResources::ResourceManager for path naming convention.
loadResourceWhether the resource should be loaded in place (true) or not (false).
Returns
The load result.

◆ processRasterStateSources()

static ContentLoadResultRasterState nkGraphics::ContentLoader::processRasterStateSources ( const nkMemory::StringView sources,
bool  loadResource = true 
)
static

Loads a raster state declaration, from memory.

Parameters
sourcesThe memory chunk to interpret.
loadResourceWhether the resource should be loaded in place (true) or not (false).
Returns
The load result.

◆ processRasterStateTree()

static ContentLoadResultRasterState nkGraphics::ContentLoader::processRasterStateTree ( nkExport::Node tree,
bool  loadResource = true 
)
static

Loads a raster state declaration, from an existing tree.

Parameters
treeThe tree to interpret.
loadResourceWhether the resource should be loaded in place (true) or not (false).
Returns
The load result.

◆ loadCameraDeclaration()

static ContentLoadResultCamera nkGraphics::ContentLoader::loadCameraDeclaration ( const nkMemory::StringView pathFromData)
static

Loads a camera declaration, from a file.

Parameters
pathFromDataThe file path, relative to working directory. See nkResources::ResourceManager for path naming convention.
Returns
The load result.

◆ processCameraSources()

static ContentLoadResultCamera nkGraphics::ContentLoader::processCameraSources ( const nkMemory::StringView sources)
static

Loads a camera declaration, from memory.

Parameters
sourcesThe memory chunk to interpret.
Returns
The load result.

◆ processCameraTree()

static ContentLoadResultCamera nkGraphics::ContentLoader::processCameraTree ( nkExport::Node tree)
static

Loads a camera declaration, from an existing tree.

Parameters
treeThe tree to interpret.
Returns
The load result.

◆ loadRenderQueueDeclaration()

static ContentLoadResultRenderQueue nkGraphics::ContentLoader::loadRenderQueueDeclaration ( const nkMemory::StringView pathFromData)
static

Loads a render queue declaration, from a file.

Parameters
pathFromDataThe file path, relative to working directory. See nkResources::ResourceManager for path naming convention.
Returns
The load result.

◆ processRenderQueueSources()

static ContentLoadResultRenderQueue nkGraphics::ContentLoader::processRenderQueueSources ( const nkMemory::StringView sources)
static

Loads a render queue declaration, from memory.

Parameters
sourcesThe memory chunk to interpret.
Returns
The load result.

◆ processRenderQueueTree()

static ContentLoadResultRenderQueue nkGraphics::ContentLoader::processRenderQueueTree ( nkExport::Node tree)
static

Loads a render queue declaration, from an existing tree.

Parameters
treeThe tree to interpret.
Returns
The load result.

◆ appendCompositorNodeFromFile()

static ContentLoadResultCompositorNode nkGraphics::ContentLoader::appendCompositorNodeFromFile ( const nkMemory::StringView pathFromData,
Compositor parent 
)
static

Appends a node into a compositor, parsed from a file.

Parameters
pathFromDataThe path of the file to load, relative to the working directory. See nkResources::ResourceManager for path naming conventions.
parentThe compositor to append the node to.
Returns
The resulting node parsed.
Remarks
The node returned will be already appended to the compositor.

◆ appendCompositorNodeFromSources()

static ContentLoadResultCompositorNode nkGraphics::ContentLoader::appendCompositorNodeFromSources ( const nkMemory::StringView sources,
Compositor parent 
)
static

Appends a node into a compositor, parsed from a source.

Parameters
sourcesThe sources to parse.
parentThe compositor to append the node to.
Returns
The resulting node parsed.
Remarks
The node returned will be already appended to the compositor.

◆ appendCompositorNodeFromTree()

static ContentLoadResultCompositorNode nkGraphics::ContentLoader::appendCompositorNodeFromTree ( nkExport::Node tree,
Compositor parent 
)
static

Appends a node into a compositor, parsed from a tree.

Parameters
treeThe tree to get the compositor node from.
parentThe compositor to append the node to.
Returns
The resulting node parsed.
Remarks
The node returned will be already appended to the compositor.

The documentation for this class was generated from the following file: